[DOCS] Adds the structure of the ES|QL docs#789
Conversation
szabosteve
added
the
Area: Documentation
szabosteve
requested review from
marciw and
swallez
and removed request for
marciw
marciw
left a comment
marciw
left a comment
There was a problem hiding this comment.
LGTM with minor suggestions
swallez
left a comment
swallez
left a comment
There was a problem hiding this comment.
I added the text for each of the sections. This doesn't include the actual examples, and can be used a blueprint for other languages (there are few java-specific terms though)
…lasticsearch-java into szabosteve/esql-docs-structure
marciw
left a comment
marciw
left a comment
There was a problem hiding this comment.
@szabosteve I did another review for clarity, conciseness, and style.
@swallez My edits are mostly for @szabosteve (I'm trying to get more familiar with our writing style and best practices here) but you're welcome to review too!
Co-authored-by: Marci Windsheimer <333176+marciw@users.noreply.github.com>
|
@l-trotta can you create sample code for the various sections? Some of it can be imported from the blog post you wrote. |
|
code examples added! just one thing, @swallez correct me if I'm wrong, but since we don't have an adapter for the columnar format I think we should move its explanation so that it's not grouped with the adapters. |
|
@l-trotta indeed. This PR served as a blueprint for all clients documentation. Let's remove the columnar format for now and re-add it once we have the Arrow integration. |
|
@szabosteve ready! |
4 participants
Overview
This PR adds an
esql.asciidocfile to the docs that contains the basic structure of the ES|QL documentation. As thehelpersare documented under theUsagesection in the Java book, the ES|QL documentation is proposed to be under theUsagesection.@swallez Every feedback is welcome (placement, structure, content, titles, etc). Please let me know what you think!
Preview
ES|QL in the Java client